﻿
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- saved from url=(0014)about:internet -->
<html xmlns:msxsl="urn:schemas-microsoft-com:xslt" xmlns:mssdk="winsdk" xmlns:script="urn:script" xmlns:build="urn:build" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<meta name="Description" content="IDebugClient interface"/>
<meta name="MSHAttr" content="PreferredSiteName:MSDN"/>
<meta name="MSHAttr" content="PreferredLib:/library/windows/hardware"/>
<title>IDebugClient</title>

<meta name="MS-HAID" content="IDebugClient_3f5f6372-0e7d-4050-b09a-b7776ff8bf7c.xml"/>


<link rel="STYLESHEET" type="text/css" HREF="../common/backsdk4.css"/>





<style>
html,div { margin: 0; padding: 0;}

body {
	padding: 0px;
	margin: 0px;
	overflow: auto;
	height: 100%;
}

#winchm_template_button{
	float: right;
	width: 93px;
	top: 7px;
	position: relative;
	text-align: right;
	right: 5px;
	height: auto;
}

#winchm_template_top{
	padding: 0px;
	margin: 0px;
	border-bottom: 1px solid #9B9B9B;
	background-color: #B1CEFE;
}

#winchm_template_navigation{
	margin: 0px;
	padding-top: 7px;
	padding-left: 7px;
	padding-bottom: 3px;
	padding-right: 0px;
	font-size: 8.5pt;
	font-family: Arial, Helvetica, sans-serif;
	font-weight: normal;
	color: #585858;
}

#winchm_template_title{
	margin: 0px;
	padding-top: 4px;
	padding-left: 7px;
	padding-bottom: 7px;
	padding-right: 0px;
	font-size: 18px; 
	font-family: Verdana, Geneva, sans-serif;
	color: #363636;
}

#winchm_template_content{
	margin-top: 20px;
	margin-left: 15px;
	margin-bottom: 20px;
	margin-right: 15px;
	width: auto  !important;
	width: 100%;
}

#winchm_template_footer{
	border-width: 1px;
	border-color: #B1CEFE;
	border-top-style: solid;
	margin-top: 15px;
	margin-left: 15px;
	margin-bottom: 20px;
	margin-right: 15px;
	padding-top: 7px;
	padding-left: 0px;
	padding-bottom: 0px;
	padding-right: 0px;
	font-family: arial, helvetica, sans-serif;
	font-size: 8.5pt;
	color: #696969;
	width: auto;
	text-align: left;
}


#winchm_template_container{
	margin: 0px;
	padding: 0px;
	position: static;
	padding-bottom: 3px;
	overflow: auto;
	background-color: #FFFFFF;
}


@media print
{
#winchm_template_container{
	position: static;	
	margin: 0px;
	padding: 5px;
	
	width: auto;
	height: auto;
	overflow: auto;
}
#winchm_template_button{
visibility:hidden;
}
}

#winchm_template_navigation A:link	{text-decoration: none; color:#004080}
#winchm_template_navigation A:visited  {text-decoration: none; color: #004080}
#winchm_template_navigation A:active {text-decoration: none; color: #004080 }
#winchm_template_navigation A:hover {text-decoration: none;color: #0080FF}

A:link	{text-decoration: underline; color:#0033CC}
A:visited  {text-decoration: underline; color: #0033CC}
A:active {text-decoration: underline; color: #0033CC }
A:hover {text-decoration: underline;color: #FF0000;}
</style>
<script type="text/javascript">
function isMobile(){
Agent = window.navigator.userAgent;
if (Agent.indexOf("iPhone")>=1 || Agent.indexOf("iPad")>=1 || Agent.indexOf("iPod")>=1 || Agent.indexOf("Android")>=1){
return true;
}else{
return false;	
}

}
function d_onresize(){
if (window.navigator.userAgent.indexOf("MSIE")>=1){
document.getElementById('winchm_template_container').style.pixelWidth = document.body.offsetWidth - 3;
document.getElementById('winchm_template_container').style.pixelHeight = document.body.offsetHeight - document.getElementById('winchm_template_top').offsetHeight - 4;
}
document.getElementById('winchm_template_container').style.top = document.getElementById('winchm_template_top').offsetHeight + 'px';
}

function d_onbeforeprint(){
document.getElementById('winchm_template_container').style.width = 'auto';
document.getElementById('winchm_template_container').style.height = 'auto';
}

function d_onafterprint(){
d_onresize();
}

if(!isMobile()){

window.onload = d_onresize;
window.onresize = d_onresize;
window.onbeforeprint = d_onbeforeprint;
window.onafterprint = d_onafterprint;

document.write("<style>\n");
document.write("body {overflow: hidden;}\n");
document.write("#winchm_template_container {position: absolute;overflow: auto;top : 0px;right: 0px;bottom: 0px;left: 0px;}\n");
document.write("</style>\n");
}

</script>
</head>
<body><script language="JavaScript" type="text/JavaScript">
function syn(){
if(parent.nav.tree){
 if(parent.nav.tree.loaded){
  parent.nav.tree.selectNode(290);
 }else{
  setTimeout("syn()",500);
}
  }else{
  setTimeout("syn()",500);
  }}
if(parent!=self){
  setTimeout("syn()",100);
}else{
  parent.location.href = "../../index.htm?page=debugger/idebugclient.htm";
}
originalOnload = window.onload;
if(originalOnload==null){
window.onload = function(){parent.contentLoaded = true;};
}else{
window.onload = function(){originalOnload();parent.contentLoaded = true;};
}
</script> 


<div id="winchm_template_top">
	<div id="winchm_template_button"><A href="getsymbolinformationwideex.htm" title="Previous topic"><img id="winchm_template_prev" alt="Previous topic" src="../template2/btn_prev_n.gif" border="0"></a><A href="addprocessoptions.htm" title="Next topic"><img id="winchm_template_next" alt="Next topic" src="../template2/btn_next_n.gif" border="0"></a></div>
	<div id="winchm_template_navigation">Help &gt; 
<A href="introduction6.htm">Debugging Tools for Windows (WinDbg, KD, CDB, NTSD)</A> &gt; <A href="debugging_resources.htm">Debugging Resources</A> &gt; <A href="debugger_engine_and_extension_apis.htm">Debugger Engine and Extension APIs</A> &gt; <A href="using_the_debugger_engine_api.htm">Using the Debugger Engine API</A> &gt; <A href="debugger_engine_reference.htm">Debugger Engine Reference</A> &gt; <A href="client_com_interfaces.htm">Debug Engine Interfaces</A> &gt; </div>
	<div id="winchm_template_title">IDebugClient</div>
</div>
<div id="winchm_template_container">
	<div id="winchm_template_content"><div id="mainSection"><h2>Members</h2>
<p>The <b xmlns:loc="http://microsoft.com/wdcml/l10n">IDebugClient</b> interface inherits from the <b>IUnknown</b> interface. <b>IDebugClient</b> also has these types of members:</p>
<ul>
<li><a href="#Bookmark290">Methods</a></li>
</ul>
<h3><a id="methods"></a>Methods</h3>
<p>The <b>IDebugClient</b> interface has these methods.</p>
<table id="memberListMethods" class="members">
<tr>
<th align="left" width="37%">Method</th>
<th align="left" width="63%">Description</th>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark291"><b>AddProcessOptions</b></a></td>
<td align="left" width="63%">
<p>Adds the process options to those options that affect the current process.
</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark292"><b>AttachKernel</b></a></td>
<td align="left" width="63%">
<p>Connects the debugger engine to a kernel target.
</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark293"><b>AttachProcess</b></a></td>
<td align="left" width="63%">
<p>Connects the debugger engine to a user-mode process.</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark294"><b>ConnectProcessServer</b></a></td>
<td align="left" width="63%">
<p>Connects to a process server.</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark295"><b>ConnectSession</b></a></td>
<td align="left" width="63%">
<p>Joins the client to an existing debugger session.</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark296"><b>CreateClient</b></a></td>
<td align="left" width="63%">
<p>Creates a new client object for the current thread.</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark297"><b>CreateProcess</b></a></td>
<td align="left" width="63%">
<p>Creates a process from the specified command line.
</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark298"><b>CreateProcessAndAttach</b></a></td>
<td align="left" width="63%">
<p> Create a process from a specified command line, then attaches to another user-mode process.</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark299"><b>DetachProcesses</b></a></td>
<td align="left" width="63%">
<p>Detaches the debugger engine from all processes in all targets, resuming all their threads.
</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark300"><b>DisconnectProcessServer</b></a></td>
<td align="left" width="63%">
<p>Disconnects the debugger engine from a process server.</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark301"><b>DispatchCallbacks</b></a></td>
<td align="left" width="63%">
<p>Enables the debugger engine to use the current thread for callbacks.
</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark302"><b>EndSession</b></a></td>
<td align="left" width="63%">
<p>Ends the current debugger session.</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark303"><b>ExitDispatch</b></a></td>
<td align="left" width="63%">
<p>Causes the <a href="#Bookmark301"><b>DispatchCallbacks</b></a> method to return.</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark304"><b>FlushCallbacks</b></a></td>
<td align="left" width="63%">
<p> Forces any remaining buffered output to be delivered to the <a href="#Bookmark819"><b>IDebugOutputCallbacks</b></a> object registered with this client.</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark305"><b>GetEventCallbacks</b></a></td>
<td align="left" width="63%">
<p>Returns the event callbacks object registered with this client.
</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark306"><b>GetExitCode</b></a></td>
<td align="left" width="63%">
<p>Returns the exit code of the current process if that process has already run through to completion.
</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark307"><b>GetIdentity</b></a></td>
<td align="left" width="63%">
<p>Returns a string describing the computer and user this client represents.
</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark308"><b>GetInputCallbacks</b></a></td>
<td align="left" width="63%">
<p>Returns the input callbacks object registered with this client.</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark309"><b>GetKernelConnectionOptions</b></a></td>
<td align="left" width="63%">
<p>Returns the connection options for the current kernel target.
</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark310"><b>GetOtherOutputMask</b></a></td>
<td align="left" width="63%">
<p>Returns the output mask for another client.
</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark311"><b>GetOutputCallbacks</b></a></td>
<td align="left" width="63%">
<p>Returns the output callbacks object registered with the client.
</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><b>GetOutputLinePrefix</b></td>
<td align="left" width="63%">
<p></p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark312"><b>GetOutputMask</b></a></td>
<td align="left" width="63%">
<p>Returns the output mask currently set for the client.</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><b>GetOutputWidth</b></td>
<td align="left" width="63%">
<p></p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark313"><b>GetProcessOptions</b></a></td>
<td align="left" width="63%">
<p>Retrieves the process options affecting the current process.
</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark314"><b>GetRunningProcessDescription</b></a></td>
<td align="left" width="63%">
<p>Returns a description of the process that includes the executable image name, the service names, the MTS package names, and the command line.</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark315"><b>GetRunningProcessSystemIdByExecutableName</b></a></td>
<td align="left" width="63%">
<p> Searches for a process with a given executable file name and return its process ID.
</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark316"><b>GetRunningProcessSystemIds</b></a></td>
<td align="left" width="63%">
<p> Returns the process IDs for each running process.</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark317"><b>OpenDumpFile</b></a></td>
<td align="left" width="63%">
<p>Opens a dump file as a debugger target.
</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark318"><b>OutputIdentity</b></a></td>
<td align="left" width="63%">
<p> Formats and outputs a string describing the computer and user this client represents.
</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark319"><b>OutputServers</b></a></td>
<td align="left" width="63%">
<p>Lists the servers running on a given computer.
</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark320"><b>RemoveProcessOptions</b></a></td>
<td align="left" width="63%">
<p>Removes process options from those options that affect the current process.
</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark321"><b>SetEventCallbacks</b></a></td>
<td align="left" width="63%">
<p>Registers an event callbacks object with this client.
</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark322"><b>SetInputCallbacks</b></a></td>
<td align="left" width="63%">
<p>Registers an input callbacks object with the client.</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark323"><b>SetKernelConnectionOptions</b></a></td>
<td align="left" width="63%">
<p>Updates some of the connection options for a live kernel target.
</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark324"><b>SetOtherOutputMask</b></a></td>
<td align="left" width="63%">
<p>Sets the output mask for another client.
</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark325"><b>SetOutputCallbacks</b></a></td>
<td align="left" width="63%">
<p>Registers an output callbacks object with this client.</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><b>SetOutputLinePrefix</b></td>
<td align="left" width="63%">
<p></p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark326"><b>SetOutputMask</b></a></td>
<td align="left" width="63%">
<p>Sets the output mask for the client.</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><b>SetOutputWidth</b></td>
<td align="left" width="63%">
<p></p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark327"><b>SetProcessOptions</b></a></td>
<td align="left" width="63%">
<p>Sets the process options affecting the current process.</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark328"><b>StartProcessServer</b></a></td>
<td align="left" width="63%">
<p>Starts a process server.</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark329"><b>StartServer</b></a></td>
<td align="left" width="63%">
<p> Starts a debugging server.
</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark330"><b>TerminateProcesses</b></a></td>
<td align="left" width="63%">
<p>Attempts to terminate all processes in all targets.</p>
</td>
</tr>
<tr data="declared;">
<td align="left" width="37%"><a href="#Bookmark331"><b>WriteDumpFile</b></a></td>
<td align="left" width="63%">
<p>Creates a user-mode or kernel-mode crash dump file.
</p>
</td>
</tr>
</table>
<p> </p>
<h2>Requirements</h2>
<table>
<tr>
<th width="30%">
<p>Header</p>
</th>
<td width="70%">
<dl>
<dt>Dbgeng.h (include Dbgeng.h)</dt>
</dl>
</td>
</tr>
</table>
<h2><a id="see_also"></a>See also</h2>
<dl>
<dt><a href="#Bookmark332"><b>IDebugClient2</b></a></dt>
<dt><a href="#Bookmark341"><b>IDebugClient3</b></a></dt>
<dt><a href="#Bookmark346"><b>IDebugClient4</b></a></dt>
<dt><a href="#Bookmark353"><b>IDebugClient5</b></a></dt></dl></div></div>	
	<div id="winchm_template_footer">Copyright &copy; 2019. All rights 
reserved. (To change the copyright info, just edit it in template.)</div>
</div>

</body>
</html>
